<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width"><meta content="telephone=no" name="format-detection"><meta name="description" content="AutocJs - 是一个专门用来生成文章导读（Table of Contents）导航的 JavaScript 工具。"><meta name="keywords" content="AutocJs,Article,Outline,JavaScript,jQuery,jQuery Plugin"><title>Autoc.Js</title><link href="css/autoc.css" rel="stylesheet"><style>.paper{
  margin:2em;
  padding:3.5em;
  background-color:#fff;
  box-shadow: 0 0 15px #ddd;
  overflow:hidden;
}
.header{
  margin:0 auto;
  text-align:center;
  overflow:hidden;
}
.article{
  padding:1em;
  font-size: 16px;
}
pre{
  padding:2em;
  background-color:#f8f8f8;
  font-family: "Courier New", Arial, sans-serif;
}
code{
  font-size: 14px;
}</style></head><body><div class="paper"><div class="header"><h1 class="title">AutocJs</h1></div><article class="article" id="article"><p>AutocJs 是一个专门用来生成文章导读（Table of Contents）导航的 JavaScript 工具（原 autocjs 的重构版本，不依赖任何JS库）。AutocJs
会查找文章指定区域中的所有 h1~h6 的标签，并自动分析文章段落间的层次结构，生成文章的导读导航。</p><h2>创作灵感</h2><p>AnchorJS 是 AutocJs 的创作灵感来源。既然 AnchorJS 可创建标题的链接，为什么不直接给文章生成一个文章导读（Table of Contents）导航呢？ 于是就有了
AutocJs。</p><h2>特点</h2><ul><li>支持 UMD 规范；</li><li>拥有 AnchorJS 基础功能；</li><li>支持中文和英文标题文字生成ID；</li><li>支持生成独立的侧边栏导航菜单；</li><li>支持直接在文章中生成文章导读导航；</li><li>自动分析标题关系，生成段落层级索引值；</li><li>可以作为 jQuery 插件使用；</li><li>界面简洁大方；</li><li>配置灵活，丰富，让你随心所欲掌控 AutocJs；</li></ul><h2>安装说明</h2><h3>npm install</h3><pre></pre><h3>CDN 调用</h3><pre></pre><h3>调用本地JS文件</h3><pre></pre><h2>使用说明</h2><pre></pre><h2>Options</h2><h3>article</h3><ul><li>Type: String</li><li>Default: '#article'</li></ul><p>可选，用来指定页面中显示文章正文的 DOM 节点的 ID 选择器。</p><h3>selector</h3><ul><li>Type: String</li><li>Default: 'h1,h2,h3,h4,h5,h6'</li></ul><p>可选，用来指定 article 节点下，要生成导航的标题标签的选择器。</p><h3>title</h3><ul><li>Type: String</li><li>Default: '文章导读'</li></ul><p>可选，用来指定文章导读导航菜单的标题文字。</p><h3>position</h3><ul><li>Type: String</li><li>Default: 'outside'</li></ul><p>可选，用来指定文章导读导航菜单的显示位置：outside - 生成侧边栏菜单，inside - 直接在文章正文区域的开始位置生成导航菜单。</p><p>只有设置了 isGenerateOutline 为 true，position 参数才会起效。</p><h3>anchorURL</h3><ul><li>Type: String</li><li>Default: ''</li></ul><p>可选，用来指定文章标题锚点链接图标的链接地址：'' - 点击链接页面滚动到标题位置，其它 URL 值 - 就直接跳转到指定页面了</p><h3>anchorAt</h3><ul><li>Type: String</li><li>Default: 'front'</li></ul><p>可选，用来指定文章标题锚点链接图标的显示位置：'front' - 现在在文章标题前面，'end' - 显示到标题末尾。</p><h3>isGenerateOutline</h3><ul><li>Type: Boolean</li><li>Default: false</li></ul><p>可选，用来指定是否文章导读导航菜单：true - 生成菜单，false - 不生成菜单（这样配置基本和 AnchorJS 功能一样了）。</p><h3>isGenerateOutlineChapterCode</h3><ul><li>Type: Boolean</li><li>Default: true</li></ul><p>可选，用来指定是否文章导读导航菜单是否显示文章段落层次的索引编号：true - 显示编号，false - 不显示编号。</p><h3>isGenerateHeadingChapterCode</h3><ul><li>Type: Boolean</li><li>Default: false</li></ul><p>可选，用来指定是否在文章标题前面显示文章段落层次的索引编号：true - 显示编号，false - 不显示编号。</p><h3>isGenerateHeadingAnchor</h3><ul><li>Type: Boolean</li><li>Default: true</li></ul><p>可选，用来指定是否在文章标题位置生成锚点链接图标：true - 生成锚点链接图标，并给标题添加 ID 属性，false - 不生成锚点链接图标，仅给标题添加 ID 属性。</p><h2>Properties</h2><h3>defaults</h3><ul><li>Type: Objects</li></ul><p>静态属性，存储的是 Autoc 对象默认配置信息。</p><h3>attributes</h3><ul><li>Type: Objects</li></ul><p>存储的是 AutocJs 对象当前使用中的配置选项。</p><h3>elements</h3><ul><li>Type: Objects</li></ul><p>存储的是 AutocJs 对象（创建的）相关的 DOM 元素。</p><h3>data</h3><ul><li>Type: Objects</li></ul><p>存储的是 AutocJs 根据标题 DOM 元素分析的数据。</p><h2>License</h2><p>JavaScript Code Licensed under MIT License.</p><p>API Documentation Licensed under CC BY 3.0</p></article></div><script src="js/autoc.js"></script><script>let navigation = new AutocJs()</script></body></html>